Skip to content

Updating a Project Snapshot

Request

Updates the metadata of a Project Snapshot.

This endpoint returns structured Project Snapshots objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the project_snapshots top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • project_snapshot_assignments (Project::Snapshots::Models::ProjectSnapshotAssignment) - Retrieves task assignments saved in snapshots. The response will include project_snapshot_assignment_ids, which references the data in the project_snapshot_assignments top-level key.
  • project_snapshot_custom_field_values (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves project custom fields saved in snapshots. The response will include project_snapshot_custom_field_value_ids, which references the data in the project_snapshot_custom_field_values top-level key.
  • project_snapshot_resources (Project::Snapshots::Models::ProjectSnapshotResource) - Retrieves the resources saved in snapshots. The response will include project_snapshot_resource_ids, which references the data in the project_snapshot_resources top-level key.
  • project_snapshot_task_custom_field_values (Project::Snapshots::Models::ProjectSnapshotCustomFieldValue) - Retrieves task custom fields saved in snapshots. The response will include project_snapshot_task_custom_field_value_ids, which references the data in the project_snapshot_custom_field_values top-level key.
  • project_snapshot_tasks (Project::Snapshots::Models::ProjectSnapshotTask) - Retrieves the tasks saved in snapshots. The response will include project_snapshot_task_ids, which references the data in the project_snapshot_tasks top-level key.
Bodyapplication/jsonrequired
project_snapshotobject
{
  "project_snapshot": {
    "title": "string",
    "description": "string",
    "replace_baseline": true
  }
}

Responses

Project Snapshots has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
project_snapshotsobject
project_snapshot_resourcesobject
project_snapshot_tasksobject
project_snapshot_custom_field_valuesobject
project_snapshot_assignmentsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "project_snapshots": {
    "property1": {
      "budget_in_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "due_date": "2019-08-24",
      "duration": "string",
      "is_baseline": true,
      "project_snapshot_assignment_ids": [
        "string"
      ],
      "project_snapshot_custom_field_value_ids": [
        "string"
      ],
      "project_snapshot_resource_ids": [
        "string"
      ],
      "project_snapshot_task_custom_field_value_ids": [
        "string"
      ],
      "project_snapshot_task_ids": [
        "string"
      ],
      "start_date": "2019-08-24",
      "status_as_text": "string",
      "status_color": "string",
      "title": "string",
      "workspace_id": "string"
    },
    "property2": {
      "budget_in_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "due_date": "2019-08-24",
      "duration": "string",
      "is_baseline": true,
      "project_snapshot_assignment_ids": [
        "string"
      ],
      "project_snapshot_custom_field_value_ids": [
        "string"
      ],
      "project_snapshot_resource_ids": [
        "string"
      ],
      "project_snapshot_task_custom_field_value_ids": [
        "string"
      ],
      "project_snapshot_task_ids": [
        "string"
      ],
      "start_date": "2019-08-24",
      "status_as_text": "string",
      "status_color": "string",
      "title": "string",
      "workspace_id": "string"
    }
  },
  "project_snapshot_resources": {
    "property1": {
      "allocated_minutes": 0,
      "name": "string",
      "project_snapshot_id": 0,
      "resource_id": 0,
      "role_id": 0,
      "user_id": 0
    },
    "property2": {
      "allocated_minutes": 0,
      "name": "string",
      "project_snapshot_id": 0,
      "resource_id": 0,
      "role_id": 0,
      "user_id": 0
    }
  },
  "project_snapshot_tasks": {
    "property1": {
      "archived": true,
      "billable": true,
      "budget_estimate_in_cents": 0,
      "description": "string",
      "due_date": "string",
      "percentage_complete": 0,
      "priority_level": 0,
      "project_plan": true,
      "project_snapshot_id": 0,
      "start_date": "string",
      "state": "string",
      "story_id": 0,
      "story_type": "string",
      "time_estimate_in_minutes": 0,
      "title": "string",
      "wbs": 0
    },
    "property2": {
      "archived": true,
      "billable": true,
      "budget_estimate_in_cents": 0,
      "description": "string",
      "due_date": "string",
      "percentage_complete": 0,
      "priority_level": 0,
      "project_plan": true,
      "project_snapshot_id": 0,
      "start_date": "string",
      "state": "string",
      "story_id": 0,
      "story_type": "string",
      "time_estimate_in_minutes": 0,
      "title": "string",
      "wbs": 0
    }
  },
  "project_snapshot_custom_field_values": {
    "property1": {
      "custom_field_name": "string",
      "subject_id": 0,
      "subject_type": "string",
      "value": "string",
      "value_type": "string"
    },
    "property2": {
      "custom_field_name": "string",
      "subject_id": 0,
      "subject_type": "string",
      "value": "string",
      "value_type": "string"
    }
  },
  "project_snapshot_assignments": {
    "property1": {
      "bill_rate_in_cents": 0,
      "cost_rate_in_cents": 0,
      "estimated_minutes": 0,
      "project_snapshot_resource_id": 0,
      "project_snapshot_task_id": 0,
      "scheduled_minutes": 0
    },
    "property2": {
      "bill_rate_in_cents": 0,
      "cost_rate_in_cents": 0,
      "estimated_minutes": 0,
      "project_snapshot_resource_id": 0,
      "project_snapshot_task_id": 0,
      "scheduled_minutes": 0
    }
  }
}